<?php
/**
 * Skyline :: Patterns & component framework
 * Copyright 2010-2011 Ian Unruh (Xerof3ar)
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace Skyline\Structure;
use Skyline\Predicate\PredicateInterface;

/**
 * A collection is a structure that holds elements
 * 
 * @author Ian Unruh (Xerof3ar) <ianunruh@gmail.com>
 * @since Class avaliable since release 1.0
 */
interface CollectionInterface extends ContainerInterface
{
	/**
	 * Add an element to the collection
	 * 
	 * @param mixed $element
	 * @return void
	 */
	public function add($element);
	
	/**
	 * Adds multiple elements to the collection
	 * 
	 * @param Traversable $elements
	 * @return void
	 */
	public function addAll($elements);
	
	/**
	 * Returns true if an element exists in the collection
	 * 
	 * @param mixed $element
	 * @return bool
	 */
	public function contains($element);
	
	/**
	 * Returns true if all given elements exist in the collection
	 * 
	 * @param Traversable $elements
	 * @return bool
	 */
	public function containsAll($elements);
	
	/**
	 * Returns true if any given elements exist in the collection
	 * 
	 * @param Traversable $elements
	 * @return bool
	 */
	public function containsAny($elements);
	
	/**
	 * Removes an element from the collection
	 * 
	 * @param mixed $element
	 * @return void
	 */
	public function remove($element);
	
	/**
	 * Removes multiple elements from the collection
	 * 
	 * @param Traversable $elements
	 * @return void
	 */
	public function removeAll($elements);
	
	/**
	 * Returns this collection as a simple PHP array
	 * @return mixed[]
	 */
	public function toArray();
	
	/**
	 * Sets the predicate used to validate this collection
	 * 
	 * @param PredicateInterface $predicate
	 * @return void
	 */
	public function setPredicate(PredicateInterface $predicate);
}